package cj.fwmobile.sfa.android.pez.menu;

/**
 * CustomMenuItem class
 * 
 * This is class basically a container for you menu items.
 * 
 * @author LeeSangYong
 */
public class CustomMenuItem {

	/**
	 * Some global variables.
	 */
	private String mCaption = null;
	private int mImageResourceId = -1;
	private int mId = -1;

	/**
	 * Use this method to set the caption displayed under the icon for a menu
	 * item.
	 * 
	 * @param String
	 *            caption
	 * @return void
	 */
	public void setCaption(String caption) {
		mCaption = caption;
	}

	/**
	 * Use this method to get the caption displayed under the icon for a menu
	 * item.
	 * 
	 * @return String caption
	 */
	public String getCaption() {
		return mCaption;
	}

	/**
	 * Use this method to set the resource ID for the drawable displayed for a
	 * menu item.
	 * 
	 * @param int imageResourceId
	 * @return void
	 */
	public void setImageResourceId(int imageResourceId) {
		mImageResourceId = imageResourceId;
	}

	/**
	 * Use this method to get the resource ID for the drawable displayed for a
	 * menu item.
	 * 
	 * @return int imageResourceId
	 */
	public int getImageResourceId() {
		return mImageResourceId;
	}

	/**
	 * Use this method to set an ID to be returned when this menu item is
	 * clicked. This is really for convenience only and optional.
	 * 
	 * @param int id
	 * @return void
	 */
	public void setId(int id) {
		mId = id;
	}

	/**
	 * Use this method to get an ID assigned to a menu item. This is really for
	 * convenience only and optional.
	 * 
	 * @return int id
	 */
	public int getId() {
		return mId;
	}

}
